Create Virtual Account
Virtual accounts don't act as independent money storage - they simply channel incoming payments straight to your account. These accounts cannot process outgoing payments or be linked to payment terminals. Since virtual accounts do not serve as containers for funds, there's no need for BVN verification during setup.
This endpoint is used to create a virtual account to receive payments.
POST
https://api.spotflow.co/api/v1/virtual-accounts/temporary
Headers
authorization |
|
---|---|
content-type String | application/json |
Request Body Parameters
accountName | Your desired naming for your account. |
---|---|
currency String | Note that currently, you can only create virtual accounts in NGN. |
amount Integer | Amount should be in the subunit of our supported currency i.e NGN for now. |
expiresIn String | This is optional to add. By default, the time it takes for a virtual account to expire is 30 mins. However, you can customize the time to lesser as you desire. |
Sample Request Body:
{
"accountName": "Sinzu Money",
"currency": "NGN",
"amount": 1500,
"expiresIn": 10
}
Sample Response:
200 OK
{
"id": "a57aa726-45d9-4870-b12d-f7fd82df5b2a",
"accountNumber": "5590739654",
"accountName": "SPOTFLOW/Sinzu Money",
"bankName": "Jollof Bank",
"mode": "test",
"lifecycle": "temporary"
}
Configure Webhook URL:
Note that you should receive webhook and email notifications when a created virtual account is funded. Configure the endpoint in your system to receive payment status updates whenever a created virtual account is funded. Update and add your Webhook URL on the merchant dashboard. You can do this in Settings > API & Webhooks > URLs > Webhook URL.